/*
 * Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 *
 * This file is part of Harmattan SmashMiner OpenGL game application.
 * 
 * Harmattan SmashMiner OpenGL Example Application version 1.0.0
 *  
 * Latest update: 15.4.2011
 *
 * The Harmattan SmashMiner OpenGL example application demonstrates how to use 
 * the OpenGL ES in Harmattan devices.
 *
 * This example is provided as a starting point for 3rd party
 * developers (you) to ease the implementation of OpenGL based 
 * games. Ideas, parts of code or methodologies that this
 * example application uses can be freely used without restrictions.
 *
 * See file README.txt how to build and compile this example application
 * in the Harmattan SDK environment. 
 * 
 * See file INSTALL.txt to find out what is required to run this
 * application and how to install the application to the device or
 * alternatively in QEMU-emulator.
 *
 * The LICENSE.txt file explains the license this software is provided
 * with. A copy of the same license is included in this source file.
 * 
 */

/*
 * Copyright (C) 2011 by Nokia Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef FRAMEINFO_H
#define FRAMEINFO_H

#include "defines.h"     // include this before anything else.
#ifdef SMASHMINER_CONFIG_ENABLE_GAME_REWIND_MODE

#include <QLinkedList>
#include <QGLWidget>    // just for GLfloat...

#include "gameeffect.h"

class FrameInfo
{
public:

    FrameInfo(int frameNumber, GLfloat timeStamp, GLfloat milliSeconds);

    enum StoredSpaceShipMode {
        /// Cone mode
        ConeMode = 0,
        /// Ball mode
        BallMode = 1
    };

    /// Gets frame number
    inline int frameNumber() { return storedFrameNumber; }
    /// Gets time stamp of the frame
    inline GLfloat timeStamp() { return storedTimeStamp; }
    /// Gets frame length as milliseconds
    inline GLfloat milliSeconds() { return storedMSecs; }
    /// Gets current read index for rewind mode
    inline int readIndexR() { return storedReadIndex; }
    /// Sets read index for rewind mode
    inline void setReadIndexR(int i) { storedReadIndex = i; }

    /// Gets stored space ship mode
    inline StoredSpaceShipMode mode() { return storedMode; }
    /// Sets stored space ship mode
    inline void setMode(StoredSpaceShipMode m) { storedMode = m; }

private:

    // keep frameNum as a signed value, because we want
    // to mark an invalid frame number with a value -1.
    /// Number of stored frame
    int storedFrameNumber;
    /// Time stamp of stared frame
    GLfloat storedTimeStamp;
    /// Frame length as milliseconds
    GLfloat storedMSecs;
    /// Read index fro rewind mode
    int storedReadIndex;
    /// Space ship mode
    StoredSpaceShipMode storedMode;
};

#endif  // SMASHMINER_CONFIG_ENABLE_GAME_REWIND_MODE
#endif  // FRAMEINFO_H
